Add Spec for IsWindowControlsOverlayEnabled.md by tochukwuIbeEkeocha · Pull Request #4613 · MicrosoftEdge/WebView2Feedback

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) · 2024-06-04T22:11:14Z

What

These new APIs introduce support for a Webview2 Window Controls Overlay. The Window Controls Overlay will allow developers to build apps in webview2 with 100% of the UI controlled by the browser process. Devs will be able to create their apps as borderless & caption-less windows, and have the Webview draw its own window control buttons (minimize,maximize, close, restore).

Akshanabha Chakraborty (ahqsoftwares) · 2024-10-26T14:27:07Z

Is there any ETA on when this update might come to webview2?

Co-authored-by: David Risney <dave@deletethis.net>

Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>

Co-authored-by: David Risney <dave@deletethis.net>

FrankC-msft · 2025-01-31T02:15:37Z

+
+    CoreWebView2WindowControlsOverlaySettings config = Webview2.CoreWebivew2.WindowControlsOverlaySettings;
+    config.IsEnabled = true; 
+    config.color = Color.FromARGB(0, 0, 255);


Does the order of setting these properties matter? If I set enabled=true before setting .color might there be a frame rendered of the overlay with the default color?

Please update docs to say when does the IsEnabled change take affect - immediate or batched once the UI thread has a chance to work.

Prefer: the order shouldn't matter. If order matters we'll follow up.

FrankC-msft · 2025-01-31T02:21:58Z

+  /// 
+  /// When using this you should configure your app window to not display its default
+  /// window control buttons. You are responsible for creating a title bar for your app
+  /// by using the available space to the left of the controls overlay. In doing so, 


Is this right or left conditional on the reading direction of the UI root?

Please document what happens for RTL locales - does the controls overlay render on the left instead of right?

In the text here say 'before' instead of 'left'

In RTL locales, the caption buttons still appear on the right side of the window, just like in LTR. The ordering of the buttons themselves is mirrored (Close | Maximize | Minimize), but their position remains on the right side of the window.

keeping that in mind 'left' actually fits correctly in the statement? please let me know if you still want it to be 'before' ?

FrankC-msft · 2025-01-31T02:25:04Z

+
+  /// The `TitleBarBackgroundColor` property allows you to set a background color
+  /// for the overlay. Based on the background color you choose, Webview2 
+  ///will automatically calculate a foreground and hover color that will


Is foreground color necessarily black or white? We might be leaving this undocumented to reserve the right to choose colors based on the hosting app?

They won't be white/black it will be based on the background color.
It would be helpful to include some screenshots of examples.

David Risney (david-risney)

Please update per comments, thanks!

David Risney (david-risney) · 2025-02-07T04:13:21Z

+
+    CoreWebView2WindowControlsOverlaySettings config = Webview2.CoreWebivew2.WindowControlsOverlaySettings;
+    config.IsEnabled = true; 
+    config.color = Color.FromARGB(0, 0, 255);


Please update docs to say when does the IsEnabled change take affect - immediate or batched once the UI thread has a chance to work.

Prefer: the order shouldn't matter. If order matters we'll follow up.

David Risney (david-risney) · 2025-02-07T04:35:46Z

+  [propget] HRESULT Height([out, retval] UINT32* value);
+
+
+  /// The `Height` property in raw screen pixels, allows you to set the height of the overlay and


Brad Peters (@bradp0721) Does it make sense to use raw screen pixels here vs view pixels?

Also, we should ensure that different DPI awareness doesn't create bugs with real raw pixels vs virtual DPI scaled raw pixels.

David Risney (david-risney) · 2025-02-07T04:43:01Z

+  /// for the overlay. Based on the background color you choose, Webview2 
+  ///will automatically calculate a foreground and hover color that will
+  /// provide you the best contrast while maintaining accessibility.
+  /// Defaults to #f3f3f3. This API supports transparency.


Document that it does not support changing the default color or default height for OS theming (dark/light mode and high contrast) and height.

David Risney (david-risney) · 2025-02-07T04:44:44Z

+
+  /// The `TitleBarBackgroundColor` property allows you to set a background color
+  /// for the overlay. Based on the background color you choose, Webview2 
+  ///will automatically calculate a foreground and hover color that will


They won't be white/black it will be based on the background color.
It would be helpful to include some screenshots of examples.

Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>

Co-authored-by: David Risney <dave@deletethis.net>

David Risney (david-risney)

lgtm thx

Create IsWindowControlsOverlayEnabled.md

5d6debb

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) added the API Proposal Review WebView2 API Proposal for review. label Jun 4, 2024

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) requested a review from David Risney (david-risney) June 4, 2024 22:11

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) force-pushed the api-isWindowControlsOverlayEnabled-draft branch from 2038eac to e886ba5 Compare June 4, 2024 22:17

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) mentioned this pull request Jun 4, 2024

API Review: IsWindowControlsOverlayEnabled MicrosoftEdge/WebView2Announcements#95

Open

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) force-pushed the api-isWindowControlsOverlayEnabled-draft branch 2 times, most recently from 657def7 to d395730 Compare June 7, 2024 22:18

David Risney (david-risney) requested review from Andy Luhrs (aluhrs13) and Viktoria Zlatinova (vickiez) June 12, 2024 17:03

David Risney (david-risney) requested changes Jun 14, 2024

View reviewed changes

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) force-pushed the api-isWindowControlsOverlayEnabled-draft branch 7 times, most recently from 3866c89 to bce67e9 Compare August 28, 2024 21:54

David Risney (david-risney) requested a review from Brad Peters (bradp0721) September 3, 2024 16:24

David Risney (david-risney) requested changes Sep 3, 2024

View reviewed changes

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) force-pushed the api-isWindowControlsOverlayEnabled-draft branch from bce67e9 to 700ec3a Compare September 4, 2024 20:19

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) force-pushed the api-isWindowControlsOverlayEnabled-draft branch from 700ec3a to 654b176 Compare September 11, 2024 22:30

Included a new API spec for Webview2 Window Controls Overlay

5a4eb5f

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) force-pushed the api-isWindowControlsOverlayEnabled-draft branch from 654b176 to 5a4eb5f Compare October 28, 2024 20:47

David Risney (david-risney) requested changes Oct 29, 2024

View reviewed changes

Viktoria Zlatinova (vickiez) reviewed Oct 30, 2024

View reviewed changes

Comment thread specs/WindowControlsOverlayConfiguration.md Outdated

Comment thread specs/WindowControlsOverlayConfiguration.md Outdated

Comment thread specs/WindowControlsOverlayConfiguration.md

Comment thread specs/WindowControlsOverlayConfiguration.md Outdated

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) and others added 4 commits November 1, 2024 11:18

Update specs/WindowControlsOverlayConfiguration.md

4bc0b7a

Co-authored-by: David Risney <dave@deletethis.net>

Update specs/WindowControlsOverlayConfiguration.md

a4026d9

Co-authored-by: David Risney <dave@deletethis.net>

Update specs/WindowControlsOverlayConfiguration.md

1714578

Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>

Update specs/WindowControlsOverlayConfiguration.md

b89c178

Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) and others added 2 commits November 1, 2024 11:18

Update specs/WindowControlsOverlayConfiguration.md

1221980

Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>

Update specs/WindowControlsOverlayConfiguration.md

8ff7c9e

Co-authored-by: David Risney <dave@deletethis.net>

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) force-pushed the api-isWindowControlsOverlayEnabled-draft branch from 2f02f47 to b38a178 Compare November 4, 2024 23:34

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) force-pushed the api-isWindowControlsOverlayEnabled-draft branch from b38a178 to a6cc969 Compare November 13, 2024 22:25

David Risney (david-risney) requested a review from shrinaths January 27, 2025 23:10

David Risney (david-risney) reviewed Jan 27, 2025

View reviewed changes

Comment thread specs/WindowControlsOverlayConfiguration.md Outdated

David Risney (david-risney) reviewed Jan 27, 2025

View reviewed changes

Comment thread specs/WindowControlsOverlayConfiguration.md Outdated

Update specs/WindowControlsOverlayConfiguration.md

01a2caf

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) force-pushed the api-isWindowControlsOverlayEnabled-draft branch from a6cc969 to 01a2caf Compare January 28, 2025 00:16

Viktoria Zlatinova (vickiez) reviewed Jan 28, 2025

View reviewed changes

FrankC-msft reviewed Jan 31, 2025

View reviewed changes

Raymond Chen (oldnewthing) reviewed Feb 7, 2025

View reviewed changes

Comment thread specs/WindowControlsOverlayConfiguration.md Outdated

David Risney (david-risney) requested changes Feb 7, 2025

View reviewed changes

Venkatesh Prasad (venky8951) and others added 14 commits February 18, 2025 10:40

Fix Typo in specs/WindowControlsOverlayConfiguration.md

abbe2c2

Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>

Fix Grammer in specs/WindowControlsOverlayConfiguration.md

fa8e6e5

Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>

Fix Typo specs/WindowControlsOverlayConfiguration.md

f3c9cf3

Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>

Fix Spacing issue in specs/WindowControlsOverlayConfiguration.md

ba722a8

Co-authored-by: Viktoria Zlatinova <vizlatin@microsoft.com>

Casing fix specs/WindowControlsOverlayConfiguration.md

964f28b

Co-authored-by: David Risney <dave@deletethis.net>

Fix Casing in specs/WindowControlsOverlayConfiguration.md

cfefaae

Co-authored-by: David Risney <dave@deletethis.net>

Update specs/WindowControlsOverlayConfiguration.md

12b8134

Co-authored-by: David Risney <dave@deletethis.net>

Fix Varibale names

f34e47c

Add height Varibale in the comments line 113

9790a1e

Change TitleBarBackgroundColor to BackgroundColor

0390596

Remove uncliamed statements

3d5d006

fix typo

2397d9f

rename WindowControlsOverlaySettings to WindowControlsOverlay

c880f4a

rename IsEnabled to IsVisible

b7f2a97

David Risney (david-risney) approved these changes Mar 18, 2025

View reviewed changes

		[propget] HRESULT Height([out, retval] UINT32* value);


		/// The `Height` property in raw screen pixels, allows you to set the height of the overlay and

Uh oh!

Conversation

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) commented Jun 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Akshanabha Chakraborty (ahqsoftwares) commented Oct 26, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

David Risney (david-risney) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Tochukwu Ibe-Ekeocha (tochukwuIbeEkeocha) commented Jun 4, 2024 •

edited

Loading